@types/pako

What is @types/pako?

@types/pako provides TypeScript type definitions for the pako library, which is a fast and efficient zlib port to JavaScript, primarily used for data compression and decompression.

What are @types/pako's main functionalities?

Compression

This feature allows you to compress a string using the deflate algorithm. The code sample demonstrates how to compress a simple string and output the compressed result.

const pako = require('pako');
const input = 'Hello, world!';
const compressed = pako.deflate(input, { to: 'string' });
console.log(compressed);

Decompression

This feature allows you to decompress a previously compressed string using the inflate algorithm. The code sample shows how to decompress a base64 encoded compressed string and output the original string.

const pako = require('pako');
const compressed = 'eJzT0yMAAGTvBe8=';
const decompressed = pako.inflate(compressed, { to: 'string' });
console.log(decompressed);

Gzip Compression

This feature allows you to compress a string using the gzip algorithm. The code sample demonstrates how to gzip compress a simple string and output the compressed result.

const pako = require('pako');
const input = 'Hello, world!';
const compressed = pako.gzip(input, { to: 'string' });
console.log(compressed);

Gzip Decompression

This feature allows you to decompress a previously gzip compressed string using the ungzip algorithm. The code sample shows how to ungzip decompress a base64 encoded compressed string and output the original string.

const pako = require('pako');
const compressed = 'H4sIAAAAAAAAE8tIzcnJVyjPL8pJAQCFE0oNCwAAAA==';
const decompressed = pako.ungzip(compressed, { to: 'string' });
console.log(decompressed);

Other packages similar to @types/pako

zlib

The zlib package is a core Node.js module that provides compression and decompression functionalities similar to pako. It supports both deflate and gzip algorithms. However, zlib is a native module and may offer better performance compared to pako, which is a JavaScript implementation.

node-zopfli

node-zopfli is a Node.js binding for the Zopfli compression algorithm, which is known for its high compression ratio. It supports both deflate and gzip algorithms. Compared to pako, node-zopfli may provide better compression at the cost of slower compression speed.

lz-string

lz-string is a JavaScript library for compressing and decompressing strings using LZ-based compression algorithms. It is designed to be lightweight and fast, making it suitable for client-side usage. Unlike pako, lz-string does not support gzip or deflate algorithms.

README

Installation

npm install --save @types/pako

Summary

This package contains type definitions for pako (https://github.com/nodeca/pako).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pako/v1.

Additional Details

• Last updated: Tue, 07 Nov 2023 20:08:00 GMT
• Dependencies: none

Credits

These definitions were written by Caleb Eggensperger, and Muhammet Öztürk.